fix(container): strip headers from logs using log stream specification #56
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates log handling to comply with the Docker log stream specification by stripping the 8-byte headers for multiplexed stdout/stderr streams and adds tests to verify correct behavior in both TTY and non-TTY modes.
- Added TTY detection in
Logsand a newparseMultiplexedLogsfunction to strip stream headers - Introduced comprehensive tests in
container.logs_test.gofor header stripping, stderr handling, error logging, and TTY mode - Removed the old
ReadLine-based trimming logic and replaced it withio.ReadFull/io.CopyNframe parsing
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| container/container.logs.go | Detect TTY, route logs through a new binary-frame parser |
| container/container.logs_test.go | New tests verifying header stripping, stderr, errors, and TTY |
Comments suppressed due to low confidence (1)
container/container.logs.go:23
- Inside the
containerpackage you should refer toLogsOptionswithout qualifying it withcontainer. Changecontainer.LogsOptionstoLogsOptionsfor proper compilation.
options := container.LogsOptions{
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
According to the log stream specification, the last 4 bytes of the header indicate the length of the log frame. There is an issue when a log message is exactly 10 character long, the header ends with \00\00\00\10. The current implementation uses ReadLine so it doesn't correctly read the header which results in the header being output. This is what the it looks like with the new test:
Why is it important?
Related issues